home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
BBS Toolkit
/
BBS Toolkit.iso
/
spitfire
/
sf332.zip
/
SFHELP.ZIP
/
SFHELP.DOC
< prev
next >
Wrap
Text File
|
1993-03-03
|
12KB
|
327 lines
_____________________________________________________________________________
________________ ________________
_____________ DOCUMENTATION FOR: SFHELP.EXE _____________
__________ ----------------------------------- __________
_______ Created by Buffalo Creek Software _______
____ ----------------------------------- ____
__ Copyright (C) 1987-1993 __
_ All rights reserved. _
_______________________________________
--------------------------------------
--- Release Date March 3, 1993 ---
--------------------------------------
Page 1
[1] PURPOSE OF SFHELP.EXE
--------------------------
SFHELP.EXE is a utility designed to create individual help files
(stored in SPITFIRE.HLP) for the SPITFIRE Bulletin Board System. The
very creation and utilization of SFHELP.EXE is with the user in mind.
When a user needs further instructions about a specific command, he/she
need not go through the burden of having to read over the entire HELP
file just to find the help they need for a certain command. The very
essence of SFHELP.EXE is to streamline and expediate the HELP process
for the new user as well as the experienced user who may be using a
command with which he/she is unfamiliar.
[2] USE OF SFHELP.EXE
----------------------
To boot the utility, simply type in:
C>SFHELP
You will then get to the screen where a help-file will be displayed and
the commands to operate SFHELP will appear.
The screen will look like this:
____________________________________________________________________________
╒═════════════════════════════════════════╕
│ - MAINTAIN SPITFIRE HELP FILE - │
│ BUFFALO CREEK SOFTWARE │
│ 913 - 39th Street │
│ West Des Moines, Iowa 50265 │
│ Copyright (C) by Mike Woltz, 1987-1993 │
╘═════════════════════════════════════════╛
Record Number [(helpfile #) of (maximum helpfiles)] "Name Of Command"
The purpose for SFHELP.EXE is to break down Help Menus into
individual help screens for any command about which a user
may have a question. It is more efficient than one large
help menu and saves time on the user's behalf.
<+> Next Help Record <-> Previous Help Record <A>dd Help Record
<G>et Help Record <C>hange Help Record <Q>uit
Enter Selection:
____________________________________________________________________________
Be certain to have SPITFIRE.HLP in the same directory/path as
SFHELP.EXE, otherwise you have no help record data when you boot this
utility. When finished, be certain that SPITFIRE.HLP is in the same
directory/path as SPITFIRE.EXE!
Page 2
[3] COMMANDS EXPLAINED
-----------------------
<+> Next Help Record
This will allow you to view the help record following the one that
is currently being displayed on the screen.
<-> Previous Help Record
This allows you to back up one help record from the record currently
displayed.
<A> Add Help Record
This command enables you to create a new help record that will be
immediately appended to the tail end of the existing help file.
IMPORTANT!: Do NOT accumulate more than 50 total help records in
SPITFIRE.HLP! (For more on this, refer to Section 4 of this file.)
When you enter a help record, you are restricted to 6 lines with 60
characters per line. You must use a ";" to indicate a blank line.
A "\" is used to indicate no line.
<G> Get Help Record
This allows you to go to a specific help record. When you enter
this command, the program will ask for the record's number you wish
to see. Simply key in the record number and SFHELP will take you
directly to that record.
<C> Change Help Record
This command can be used for a dual purpose. It can be used to
change a record, should you find a mistake in it, or it can be used
to overwrite an old help record by entering a new record.
IMPORTANT!: Do NOT combine or exchange help records! (For more on
this, refer to Section 4 of this file.)
<Q> Quit
This command will dump you back to DOS.
[4] CURSOR CONTROL
-------------------
When adding or editing a help record the entire six line help screen
is displayed. Several options are available for positioning the cursor
around in the help work area. These are:
Left Arrow Key - This will move the cursor left 1 character position.
Right Arrow Key - This will move the cursor right 1 character position.
Page 3
Up Arrow Key - This will move the cursor up 1 line and place the
cursor at the beginning of that line.
Down Arrow Key - This will move the cursor down 1 line and place the
cursor at the beginning of that line.
End Key - This will move the cursor to the end of the current line.
Home Key - This will move the cursor to the beginning of the current
line.
Backspace Key - This will delete the character to the left of the current
cursor position.
Del Key - This will delete the character in the current cursor
position.
Escape Key - When editing a record this will terminate the editing and
return you to the main sfhelp screen.
Insert Key - The insert key can be used to activate and deactivate the
the insert mode. The present mode is always displayed in
the lower left hand portion of the screen. It will be
displayed either as Insert Active or Insert Inactive.
[5] HELP RECORD INFORMATION
----------------------------
There are 3 basic rules that must ALWAYS be followed when working with
SFHELP.EXE! These rules MUST be followed at all costs. To do otherwise is
only inviting disaster in this arena of SPITFIRE.
[A] You CANNOT accumulate more than 55 help records!
------------------------------------------------------
To do so is not only useless, but hazardous to the efficiency of
SPITFIRE! There are only 55 commands to deal with in SPITFIRE, so
it stands to reason that there is no need to add help records for
commands that do not even exist.
If you attempt to add a new help record and 55 already exist, the
message, "The maximum number of records are already written!" is
displayed to the screen.
[B] You CANNOT combine help records!
-------------------------------------
First off, combining help records defeats the entire purpose of SFHELP.
If one combines the <P>age the Sysop help record with the <C>omment to
Sysop help record, one is only succeeding in confusing the new user
and frustrating the experienced user.
Page 4
[C] You CANNOT exchange help records!
--------------------------------------
Exchanging the help records can cause unparalleled pandemonium for your
help records. Each help record is affixed a numeric designation that
SPITFIRE will look for when asked to display the command explanation
held in SPITFIRE.HLP. If one has exchanged the help record for
"<D>ownload a File" with the help record for "<V>iew a Text File",
(and vice-versa) imagine the utter confusion of the user who asks for
information on downloading and only succeeds in getting a discourse on
viewing textfiles!
IMPORTANT!
----------
The following section lists the all of SFHELP's numeric designations
coupled with their respective help record descriptions. If you are ever
in doubt as to what help file belongs with which help record number, be
certain to consult Section 5 to insure complete accuracy!
[5] RECORD CONFIGURATION
--------------------------
_____________________________________________________________________________
[1] Page Sysop
[2] Goodbye & Log Off
[3] Expert Level
[4] Go To Sysop Section
[5] Sysop Configurable Feature - File Menu
[6] Sysop Configurable Feature - Main Menu
[7] Change File Area
[8] List Files
[9] Erase A File
[10] Download A File
[11] Read A Textfile
[12] Jump/File Section To Message Section
[13] Quit To Main Menu
[14] View A file archive
[15] New Files
[16] File Description Text Search
[17] Find A File
[18] ? Help
[19] Help With File Protocols
[20] Upload A File
[21] Jump/Main Menu To Message Section
[22] Jump - Main Menu To File Section
[23] Bulletins
[24] Comment To Sysop
[25] List Users
[26] Locate A User
[27] Initial Welcome
[28] System Information
[29] Newsletter
[30] Your Statistics
Page 5
[31] Other BBS Names & Numbers
[32] Add To BBS List
[33] Questionnaire Menu
[34] Browse Messages
[35] Change Message Conference
[36] Read Messages
[37] Hurry-Scan Messages
[38] Enter A Message
[39] Your Messages
[40] Message Text Search
[41] Jump/Message Section to File Menu
[42] Jump/Message Section to Main Menu
[43] Add To Batch
[44] View Tagged/Queued List
[45] Begin File Transfer
[46] Remove File Batch Queue
[47] Start New Batch Queue
[48] Quit Batch
[49] Batch Help
[50] SPITFIRE Doors
[51] Non-Stop Message Capture
[52] Sysop Configurable Feature - Message Menu
[53] Alter Message Conference Queue
[54] Shuffle Files
[55] LAKOTA (QWK Mail System)
_____________________________________________________________________________
IMPORTANT!
----------
Keep this list handy in all circumstances when you are using SFHELP.EXE
to edit the SPITFIRE.HLP file to your taste. Remember, a misplaced or
erroneous help file could truly bungle your SPITFIRE.HLP file and add to
the user's frustration and confusion.
If you have any problems or questions about SFHELP.EXE or any other
SPITFIRE utility, feel free to contact Buffalo Creek BBS (515-225-8496). We
will try to answer any questions pertaining to this utility (and others) and
work with you towards solving your problem. Thank you for using SPITFIRE!